home *** CD-ROM | disk | FTP | other *** search
/ Skunkware 5 / Skunkware 5.iso / src / Games / xpilot-3.3.1 / README.MAPS < prev    next >
Text File  |  1995-07-08  |  13KB  |  369 lines

  1. I've severely hacked over the startup configuration process for
  2. XPilot, to some extent as discussed on the XPilot mailing list.   My
  3. changes affect command-line options, map file format, and local config
  4. file format.
  5.  
  6. What this means is that you can now control any configuration option
  7. from the command line, the map file, or the local defaults file - the
  8. system is completely orthogonal.   In general, options specified on
  9. the command line take precedence over options specified in the map
  10. file, which take precedence over options specified in the local
  11. defaults file, all of which take precedence over the built-in
  12. defaults.   This precedence can be overridden in some ways.
  13.  
  14. Map files and config files have exactly the same format - in fact, you
  15. can specify map data in the config file if you want, although of
  16. course a map file will generally override this.   The format is fairly
  17. simple - each configuration option is specified as a name, followed by
  18. a colon, followed by the associated data.
  19.  
  20. Names must start with an alphabetic character, and may contain any
  21. character other than a ':' internally, although internal whitespace is
  22. ignored.   Name comparisons are case-independant, so the names ``shot
  23. speed'', ``ShotSpeed'' and ``S hoT spEEd'' are all equivalent.
  24.  
  25. Values may contain any character other than '#', newline and NUL, but
  26. leading and trailing whitespace is discarded.   Values may include a
  27. \override: prefix, which overrides the command-line value in the case
  28. of the map file, and overrides both the command-line value and the map
  29. value in the case of the configuration file.
  30.  
  31. Multi-line values (e.g, the map data) may be specified using the
  32. \multiline: <delimiter> prefix - all subsequent lines up to but not
  33. including a line which matches the remainder of the value field will
  34. be stored as the value, and the delimiters will be discarded (see
  35. below for an example).   If no delimiter is found, the end of the file
  36. is silently taken as a delimiter.
  37.  
  38. Blank lines and lines with only whitespace and comments are ignored,
  39. and any characters following a # character on a line are also ignored.
  40.  
  41. Options specified on the command line may use the same names as are
  42. specified in config files, although special command-line-specific
  43. names have been provided as well for backwards compatibility (see
  44. below).
  45.  
  46. A typical map file might look something like this (a bit truncated, of
  47. course):
  48.  
  49. mapWidth: 10
  50. mapHeight: 10
  51. mapAuthor: Ted Lemon
  52. mapName: InnerSpace
  53. mapData: \multiline: foo
  54. xxxxxxxxxx
  55. x        x
  56. x        x
  57. x        x
  58. x        x
  59. x        x
  60. x        x
  61. x* *  * *x
  62. x        x
  63. xxxxxxxxxx
  64. foo
  65.  
  66. There is no imposition of order in this file - for example, the map
  67. data can appear at the beginning or in the middle, as long as the
  68. delimiter is used.
  69.  
  70. A typical local defaults file might look something like this:
  71.  
  72. gravity: \override: 0    # Nobody in their right mind wants gravity!
  73. maxRobots: 4        # More robots start to clutter things up...
  74.  
  75. The set of all possible config file, map file and command line options
  76. is enumerated in cmdline.c, and can be easily extended.   Currently,
  77. the following options are available:
  78.  
  79. option name                             default description
  80. --------------------------------------- ------- -------------------------------
  81.  
  82. mapName                    unknown    Name of the map
  83. mapAuthor                anonymous    Name of map's author
  84. mapWidth                100    Width of world
  85. mapHeight                100    Height of world
  86. mapData                    none    The map's topology
  87. gameDuration
  88. time                    0.0    Duration of game in minutes.
  89. gravity                    -0.14          Gravity strength
  90. shipMass                20.0           Mass of fighters
  91. shotMass                0.1    Mass of bullets
  92. shotSpeed                21.0    Maximum speed of bullets
  93. shotLife                60    Life of bullets in ticks
  94. fireRepeatRate
  95. fireRepeat                2    Number of frames per
  96.                         automatic fire (0=off)
  97. maxRobots
  98. robots                    4    How many robots do you want?
  99. robotsTalk                false    Do robots talk when they die,
  100.                         kill, etc.?
  101. robotsLeave                true    Do robots leave the game?
  102. robotLeaveLife                50    Max life per robot (0=off)
  103. robotLeaveScore                -90    Min score for robot to play
  104.                         (0=off)
  105. robotLeaveRatio                -5    Min ratio for robot to play
  106.                         (0=off)
  107. maxPlayerShots
  108. shots                    256    Maximum bullets present at one
  109.                         time
  110. shotsGravity                true    Are bullets afflicted by
  111.                         gravity?
  112. idleRun
  113. rawMode                    false    The robots keep playing even
  114.                         if all human players quit.
  115. noQuit                    false    The server keeps running even
  116.                         if all players have left.
  117. contactPort
  118. port                    15345    Contact port number
  119. motd                    none    File name for server-motd
  120. allowPlayerCrashes            yes    Can players overrun other
  121.                         players?
  122. allowPlayerBounces            yes    Can players bounce with other
  123.                         players?
  124. allowPlayerKilling
  125. killings                yes    Should players be allowed to
  126.                         kill one other?
  127. allowShields
  128. shields                    yes    Should we allow shields?
  129. playerStartsShielded
  130. playerStartShielded            yes    Players start with shields up
  131. shotsWallBounce                no    Do shots bounce off walls?
  132. ballsWallBounce                yes    Do balls bounce off walls?
  133. minesWallBounce                no    Do mines bounce off walls?
  134. itemsWallBounce                yes    Do items bounce off walls?
  135. missilesWallBounce            no    Do missiles bounce off walls?
  136. sparksWallBounce            no    Do thrust spark particles
  137.                         bounce off walls to give
  138.                         reactive thrust?
  139. debrisWallBounce            no    Do explosion debris particles
  140.                         bounce off walls?
  141. maxObjectWallBounceSpeed
  142. maxObjectBounceSpeed            40    The maximum allowed speed for
  143.                         objects to bounce off walls
  144. maxShieldedWallBounceSpeed
  145. maxShieldedBounceSpeed            50    The maximum allowed speed for
  146.                         a shielded player to bounce
  147.                         off walls
  148. maxUnshieldedWallBounceSpeed
  149. maxUnshieldedBounceSpeed        20    Maximum allowed speed for an
  150.                         unshielded player to bounce
  151.                         off walls
  152. maxShieldedPlayerWallBounceAngle
  153. maxShieldedBounceAngle            90    Maximum allowed angle for a
  154.                         shielded player to bounce
  155.                         off walls
  156. maxUnshieldedPlayerWallBounceAngle
  157. maxUnshieldedBounceAngle        30    Maximum allowed angle for an
  158.                         unshielded player to bounce
  159.                         off walls
  160. playerWallBounceBrakeFactor
  161. playerWallBrake                0.89    Factor to slow down players
  162.                         when they hit the wall
  163.                         (between 0 and 1)
  164. objectWallBounceBrakeFactor
  165. objectWallBrake                0.95    Factor to slow down objects
  166.                         when they hit the wall
  167.                         (between 0 and 1)
  168. objectWallBounceLifeFactor        0.80    Factor to reduce the life of
  169.                         objects after bouncing
  170.                         (between 0 and 1)
  171. wallBounceFuelDrainMult
  172. wallBounceDrain                1.0    Multiplication factor for
  173.                         player wall bounce fuel cost.
  174. wallBounceDestroyItemProb        0.0    Player wall bounce item damage
  175.                         probability.
  176. reportToMetaServer
  177. reportMeta                yes    Keep the meta server informed
  178.                         about our game?
  179. limitedVisibility            no    Should the players have a
  180.                         limited visibility?
  181. limitedLives                no    Should players have limited
  182.                         lives?
  183. worldLives
  184. lives                    0    Number of lives each player
  185.                         has (no sense without
  186.                         limitedLives)
  187. teamPlay
  188. teams                    no    Should we allow team play?
  189. teamAssign                yes    Should player be assigned to
  190.                         first non-empty team if team
  191.                         isn't set?
  192. teamImmunity                yes    Should other team members be
  193.                         immune to various shots,
  194.                         thrust etc.?
  195. emcsReprogramMines            yes    Do ECMs reprogram mines?
  196. playerMinimumStartFuel
  197. playerMinStartFuel            400.0    Minimum amount of fuel a player
  198.                         will have after being killed
  199. targetKillTeam                no    Do team members die when their
  200.                         last target explodes?
  201. targetTeamCollision
  202. targetCollision                yes    Do team members collide with
  203.                         their own target or not
  204. treasureKillTeam            no    Do team members die when
  205.                         treasure is destroyed?
  206. treasureCollisionDestroys
  207. treasureCollisionDestroy        yes    Destroy balls on collisions
  208. treasureCollisionMayKill
  209. treasureUnshieldedCollisionKills    no    Does unshielded collision kill
  210.                         player
  211. onePlayerOnly                no    One player modus
  212. timing
  213. race                    no    Race mode
  214. edgeWrap                no    Wrap around edges
  215. edgeBounce                yes    Players and bullets bounce
  216.                         when they hit the edge
  217. extraBorder                no    Give map an extra border of
  218.                         solid rock
  219. gravityPoint                0,0    If the gravity is a point
  220.                         source, where does that
  221.                         gravity originate?
  222. gravityAngle                90    If gravity is along a uniform
  223.                         line, at what angle is that
  224.                         line?
  225. gravityPointSource            false    Is gravity originating from a
  226.                         single point?
  227. gravityClockwise            false    If the gravity is a point
  228.                         source, is it clockwise?
  229. gravityAnticlockwise            false    If the gravity is a point
  230.                         source, is it anticlockwise?
  231. framesPerSecond
  232. FPS                    18    Number of frames per second
  233.                         the server should strive for
  234. allowNukes
  235. nukes                    False    Should nuclear weapons be
  236.                         allowed?
  237. allowClusters
  238. clusters                False    Should cluster weapons be
  239.                         allowed?
  240. allowModifiers
  241. modifiers                False    Should the weapon modifiers be
  242.                         allowed?
  243. allowLaserModifiers
  244. lasermodifiers                False    Can lasers be modified to be
  245.                         a different weapon?
  246. allowShipShapes
  247. ShipShapes                True    Are players allowed to define
  248.                         their own ship shape?
  249. playersOnRadar
  250. playersRadar                True    Are players visible on the
  251.                         radar
  252. missilesOnRadar
  253. missilesRadar                True    Are missiles visible on the
  254.                         radar
  255. minesOnRadar
  256. minesRadar                False    Are mines visible on the
  257.                         radar
  258. nukesOnRadar
  259. nukesRadar                True    Are nukes visible or
  260.                         highlighted on radar
  261. distinguishMissiles            True    Are different types of
  262.                         missiles distinguished
  263.                         (by length)
  264. maxMissilesPerPack            4    Number of missiles gotten by
  265.                         picking up one missile item.
  266. identifyMines                True    Are mine owner's names
  267.                         displayed
  268. shieldedItemPickup
  269. shieldItem                False    Can items be picked up while
  270.                         shields are up?
  271. shieldedMining
  272. shieldMine                False    Can mines be thrown and placed
  273.                         while shields are up?
  274. laserIsStunGun
  275. stunGun                    False    Is the laser weapon a stun gun
  276.                         weapon?
  277. nukeMinSmarts                7    Minimum number of smart
  278.                         missiles needed to make a
  279.                         nuclear variant
  280. nukeMinMines                4    Minimum number of mines needed
  281.                         to make a nuclear variant
  282. nukeClusterDamage            1.0    How much each cluster debris
  283.                         does damage wise from a nuke
  284.                         variant Also reduces number of
  285.                         particles in the explosion
  286. mineFuseTime                0.0    Time after which owned mines
  287.                         become deadly, zero means never
  288. movingItemProb                0.2    Probability for an item to
  289.                         appear as moving
  290. dropItemOnKillProb            0.5    Probability for dropping an
  291.                         item (each item) when you are
  292.                         killed
  293. detonateItemOnKillProb            0.5    Probability for undropped
  294.                         items to detonate when you are
  295.                         killed
  296. destroyItemInCollisionProb        0.0    Probability for items (some
  297.                         items) to be destroyed in a
  298.                         collision
  299. itemProbMult
  300. itemProbFact                1.0    Item Probability
  301.                         Multiplication Factor scales
  302.                         all item probabilities
  303. maxItemDensity                0.00012    Maximum density [0.0-1.0] for
  304.                         items (max items per block)
  305. itemEnergyPackProb            0    Probability for an energy pack
  306.                         to appear
  307. itemTankProb                0    Probability for an extra tank
  308.                         to appear
  309. itemECMProb                0    Probability for an ECM item
  310.                         to appear
  311. itemMineProb                0    Probability for a mine item
  312.                         to appear
  313. itemMissileProb                0    Probability for a missile item
  314.                         to appear
  315. itemCloakProb                0    Probability for a cloak item
  316.                         to appear
  317. itemSensorProb                0    Probability for a sensor item
  318.                         to appear
  319. itemWideangleProb            0    Probability for a wideangle
  320.                         item to appear
  321. itemRearshotProb            0    Probability for a rearshot item
  322.                         to appear
  323. itemAfterburnerProb            0    Probability for an afterburner
  324.                         item to appear
  325. itemTransporterProb            0    Probability for a transporter
  326.                         item to appear
  327. itemLaserProb                0    Probability for a Laser item
  328.                         to appear
  329. itemEmergencyThrustProb            0    Probability for an Emergency Thrust
  330.                         item to appear
  331. itemTractorBeamProb            0    Probability for a Tractor Beam item
  332.                         to appear
  333. itemAutopilotProb            0    Probability for an Autopilot item
  334.                         to appear
  335. itemEmergencyShieldProb            0    Probability for an Emergency Shield
  336.                         item to appear
  337. initialFuel                1000    How much fuel players start
  338.                         with
  339. initialTanks                0    How many tanks players start
  340.                         with
  341. initialECMs                0    How many ECMs players start
  342.                         with
  343. initialMines                0    How many mines players start
  344.                         with
  345. initialMissiles                0    How many missiles players start
  346.                         with
  347. initialCloaks                0    How many cloaks players start
  348.                         with
  349. initialSensors                0    How many sensors players start
  350.                         with
  351. initialWideangles            0    How many wideangles players
  352.                         start with
  353. initialRearshots            0    How many rearshots players
  354.                         start with
  355. initialAfterburners            0    How many afterburners players
  356.                         start with
  357. initialTransporters            0    How many transporters players
  358.                         start with
  359. initialLasers                0    How many lasers players
  360.                         start with
  361. initialEmergencyThrusts            0    How many emergency thrusts
  362.                         players start with
  363. initialTractorBeams            0    How many tractor/pressor beams
  364.                         players start with
  365. initialAutopilots            0    How many autopilots players
  366.                         start with
  367. initialEmergencyShields            0    How many emergency shields
  368.                         players start with
  369.